/*
 * Copyright (C) 2013  Richard Schilling. All rights reserved.
 * contact: coderroadie@gmail.com
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package android.persist.annotation;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * {@code DataStore} is a class {@link Annotation} that allows you to specify
 * how class level information should be used to configure the data store. Using
 * this annotation is optional.
 * 
 * @author Richard Schilling (coderroadie@gmail.com)
 * @since 1.0
 */
@Target(TYPE)
@Retention(RUNTIME)
public @interface DataStore {

    /**
     * Instances of the class are stored under this name. Should be a unique
     * name among all persisted classes. The default value is the value returned
     * by {@link Class#getSimpleName()}.
     * <p>
     * For example, when persisting classes to a SQLite database, this will
     * cause data for class {@code Account} to be stored in a table called
     * "fooaccounts".
     * 
     * <pre>
     * DatabaseStore(storageName = "fooaccounts")
     * public class Account {
     *   ...
     * }
     * </pre>
     * 
     * @since 1.0
     */
    String value();

}
